<!doctype html>


<html>
<head>
  <link rel="shortcut icon" href="static/images/favicon.ico" type="image/x-icon">
  <title>anim (Closure Library API Documentation - JavaScript)</title>
  <link rel="stylesheet" href="static/css/base.css">
  <link rel="stylesheet" href="static/css/doc.css">
  <link rel="stylesheet" href="static/css/sidetree.css">
  <link rel="stylesheet" href="static/css/prettify.css">

  <script>
     var _staticFilePath = "static/";
     var _typeTreeName = "goog";
     var _fileTreeName = "Source";
  </script>

  <script src="static/js/doc.js">
  </script>


  <meta charset="utf8">
</head>

<body onload="grokdoc.onLoad();">

<div id="header">
  <div class="g-section g-tpl-50-50 g-split">
    <div class="g-unit g-first">
      <a id="logo" href="index.html">Closure Library API Documentation</a>
    </div>

    <div class="g-unit">
      <div class="g-c">
        <strong>Go to class or file:</strong>
        <input type="text" id="ac">
      </div>
    </div>
  </div>
</div>





<div class="colmask rightmenu">
<div class="colleft">
    <div class="col1">
      <!-- Column 1 start -->

<div id="title">
       <span class="fn">fx.anim</span>
</div>

<hr/>


  <h2>Classes</h2>
 <div class="fn-constructor">
        <a href="interface_goog_fx_anim_Animated.html">
          goog.fx.anim.Animated</a><br/>
        <div class="class-details">An interface for programatically animated objects. I.e. rendered in
javascript frame by frame.</div>
 </div>
   
<br/>

  <div class="legend">
        <span class="key publickey"></span><span>Public</span>
        <span class="key protectedkey"></span><span>Protected</span>
        <span class="key privatekey"></span><span>Private</span>
  </div>









<div class="section">
  <table class="horiz-rule">


  </table>
</div>




  <h2>Global Functions</h2>





<div class="section">
  <table class="horiz-rule">


     <tr class="even entry private">
       <td class="access"></td>






  <td>
    <a name="goog.fx.anim.cancelAnimationFrame_"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.fx.anim.</span><span class="entryName">cancelAnimationFrame_<span class="args">()</span>
        </span>
      </div>


     <div class="entryOverview">
       Cancels an animation frame created by requestAnimationFrame_().
     </div>

   
  </td>


  <td class="view-code">
     <a href="closure_goog_fx_anim_anim.js.source.html#line189">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry private">
       <td class="access"></td>






  <td>
    <a name="goog.fx.anim.cycleAnimations_"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.fx.anim.</span><span class="entryName">cycleAnimations_<span class="args">(<span class="arg">now</span>)</span>
        </span>
      </div>


     <div class="entryOverview">
       Cycles through all registered animations.
     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">now</span>
        : <div class="fullType"><span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Number">number</a></span></div>
        <div class="entryOverview">Current time in milliseconds.</div>
     </td>
   </tr>
  </table>
      </div>
   
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="closure_goog_fx_anim_anim.js.source.html#line201">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry public">
       <td class="access"></td>






  <td>
    <a name="goog.fx.anim.registerAnimation"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.fx.anim.</span><span class="entryName">registerAnimation<span class="args">(<span class="arg">animation</span>)</span>
        </span>
      </div>


     <div class="entryOverview">
       Registers an animation to be cycled on the global timer.
     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">animation</span>
        : <div class="fullType">(<span class="type"><a href="interface_goog_fx_anim_Animated.html">goog.fx.anim.Animated</a></span><span>&nbsp;|&nbsp;</span><span class="type">null</span>)</div>
        <div class="entryOverview">The animation to register.</div>
     </td>
   </tr>
  </table>
      </div>
   
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="closure_goog_fx_anim_anim.js.source.html#line83">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry private">
       <td class="access"></td>






  <td>
    <a name="goog.fx.anim.requestAnimationFrame_"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.fx.anim.</span><span class="entryName">requestAnimationFrame_<span class="args">()</span>
        </span>
      </div>


     <div class="entryOverview">
       Requests an animation frame based on the requestAnimationFrame and
cancelRequestAnimationFrame function pair.
     </div>

   
  </td>


  <td class="view-code">
     <a href="closure_goog_fx_anim_anim.js.source.html#line158">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry public">
       <td class="access"></td>






  <td>
    <a name="goog.fx.anim.setAnimationWindow"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.fx.anim.</span><span class="entryName">setAnimationWindow<span class="args">(<span class="arg">animationWindow</span>)</span>
        </span>
      </div>


     <div class="entryOverview">
       Registers an animation window. This allows usage of the timing control API
for animations. Note that this window must be visible, as non-visible
windows can potentially stop animating. This window does not necessarily
need to be the window inside which animation occurs, but must remain visible.
See: <a href="https://developer.mozilla.org/en/DOM/window.mozRequestAnimationFrame">https://developer.mozilla.org/en/DOM/window.mozRequestAnimationFrame</a>.
     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">animationWindow</span>
        : <div class="fullType">(<span class="type"><a href="https://developer.mozilla.org/en/DOM/window">Window</a></span><span>&nbsp;|&nbsp;</span><span class="type">null</span>)</div>
        <div class="entryOverview">The window in which to animate elements.</div>
     </td>
   </tr>
  </table>
      </div>
   
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="closure_goog_fx_anim_anim.js.source.html#line132">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>






  <td>
    <a name="goog.fx.anim.tearDown"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.fx.anim.</span><span class="entryName">tearDown<span class="args">()</span>
        </span>
      </div>


     <div class="entryOverview">
       Tears down this module. Useful for testing.
     </div>

   
  </td>


  <td class="view-code">
     <a href="closure_goog_fx_anim_anim.js.source.html#line115">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry public">
       <td class="access"></td>






  <td>
    <a name="goog.fx.anim.unregisterAnimation"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.fx.anim.</span><span class="entryName">unregisterAnimation<span class="args">(<span class="arg">animation</span>)</span>
        </span>
      </div>


     <div class="entryOverview">
       Removes an animation from the list of animations which are cycled on the
global timer.
     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">animation</span>
        : <div class="fullType">(<span class="type"><a href="interface_goog_fx_anim_Animated.html">goog.fx.anim.Animated</a></span><span>&nbsp;|&nbsp;</span><span class="type">null</span>)</div>
        <div class="entryOverview">The animation to unregister.</div>
     </td>
   </tr>
  </table>
      </div>
   
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="closure_goog_fx_anim_anim.js.source.html#line99">code &raquo;</a>
  </td>
     </tr>


  </table>
</div>



  <h2>Global Properties</h2>





<div class="section">
  <table class="horiz-rule">


     <tr class="even entry public">
       <td class="access"></td>





  <a name="goog.fx.anim.TIMEOUT"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.fx.anim.</span><span class="entryName">TIMEOUT</span>
        : <div class="fullType"><span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Number">number</a></span></div>
     </div>


     <div class="entryOverview">
       Default wait timeout for animations (in milliseconds).  Only used for timed
animation, which uses a timer (setTimeout) to schedule animation.
     </div>

  </td>


  <td class="view-code">
     <a href="closure_goog_fx_anim_anim.js.source.html#line51">Code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry private">
       <td class="access"></td>





  <a name="goog.fx.anim.activeAnimations_"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.fx.anim.</span><span class="entryName">activeAnimations_</span>
        : <div class="fullType">(<span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Object">Object</a></span>.&lt;<span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Number">number</a></span>,(<span class="type"><a href="interface_goog_fx_anim_Animated.html">goog.fx.anim.Animated</a></span><span>&nbsp;|&nbsp;</span><span class="type">null</span>)&gt;<span>&nbsp;|&nbsp;</span><span class="type">null</span>)</div>
     </div>


     <div class="entryOverview">
       A map of animations which should be cycled on the global timer.
     </div>

  </td>


  <td class="view-code">
     <a href="closure_goog_fx_anim_anim.js.source.html#line60">Code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry private">
       <td class="access"></td>





  <a name="goog.fx.anim.animationDelay_"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.fx.anim.</span><span class="entryName">animationDelay_</span>
        : <div class="fullType">(<span class="type"><a href="class_goog_async_AnimationDelay.html">goog.async.AnimationDelay</a></span><span>&nbsp;|&nbsp;</span><span class="type"><a href="class_goog_async_Delay.html">goog.async.Delay</a></span><span>&nbsp;|&nbsp;</span><span class="type">null</span>)</div>
     </div>


     <div class="entryOverview">
       An interval ID for the global timer or event handler uid.
     </div>

  </td>


  <td class="view-code">
     <a href="closure_goog_fx_anim_anim.js.source.html#line76">Code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry private">
       <td class="access"></td>





  <a name="goog.fx.anim.animationWindow_"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.fx.anim.</span><span class="entryName">animationWindow_</span>
        : <div class="fullType">(<span class="type"><a href="https://developer.mozilla.org/en/DOM/window">Window</a></span><span>&nbsp;|&nbsp;</span><span class="type">null</span>)</div>
     </div>


     <div class="entryOverview">
       An optional animation window.
     </div>

  </td>


  <td class="view-code">
     <a href="closure_goog_fx_anim_anim.js.source.html#line68">Code &raquo;</a>
  </td>
     </tr>


  </table>
</div>
      <!-- Column 1 end -->
    </div>

        <div class="col2">
          <!-- Column 2 start -->
          <div class="col2-c">
            <h2 id="ref-head">Package fx</h2>
            <div id="localView"></div>
          </div>

          <div class="col2-c">
            <h2 id="ref-head">Package Reference</h2>
            <div id="sideTypeIndex" rootPath="" current="fx.anim"></div>
          </div>
          <!-- Column 2 end -->
        </div>
</div>
</div>

</body>
</html>
